/**
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a
 * copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.jasig.portal.security.xslt;

/**
 * Group Membership Helper APIs
 * 
 * @author Eric Dalquist
 * @version $Revision$
 */
public interface IXalanGroupMembershipHelper {
    /**
     * Checks if the user is a deep member of the specified group
     * 
     * @param userName Name of the user to check
     * @param groupKey internal group key (ex: local.0)
     * @return true if the user is a deep member, false otherwise
     */
    public boolean isUserDeepMemberOf(String userName, String groupKey);
    
    /**
     * Checks if the user is a deep member of the specified group
     * 
     * @param userName Name of the user to check
     * @param groupName Name to find a group via search
     * @return true if the user is a deep member, false otherwise
     */
    public boolean isUserDeepMemberOfGroupName(String userName, String groupName);
    
    /**
     * Checks if the channel is a deep member of the specified group
     * 
     * @param fname FName of the channel
     * @param groupKey internal group key (ex: local.0)
     * @return true if the channel is a deep member, false otherwise
     */
    public boolean isChannelDeepMemberOf(String fname, String groupKey);

}
